Batch API
GET Status
Overview
The Status API endpoint in the SureTax system is used to check the status of a file that was previously uploaded. To use it, you must provide a jobid, which is the unique identifier from the upload request. When queried with this jobid, the system returns the current status of the file:
1. In Progress: This status indicates that the file is currently being processed by the system. The processing may still be ongoing, and users can expect the final status to be updated once the process is complete.
2. Completed: This status signifies that the file processing has been successfully completed. All the necessary calculations and operations related to the uploaded file have been executed without any errors.
3. Failed: In the event of an error during the file processing, this status is returned. It indicates that the system encountered an issue while processing the uploaded file.Furthermore, if there are any errors in processing specific lines within the file, the SureTax system provides additional details about the line(s) that contain the error.
OperationId: GET Status
Authorization Method(s): OAuth
Verb: GET
End Point: /api/v1/Batch/Status
Overview
Example Response
{
"uploadStatus": "Completed",
"message": "",
"totalNumberOfLines": 3,
"itemsWithMessages": [
{
"itemNumber": "1",
"message": "Invalid Unit Type",
"itemStatus": "E"
},
{
"itemNumber": "1",
"message": "Invalid Unit Type",
"itemStatus": "E"
},
{
"itemNumber": "1",
"message": "Invalid Unit Type",
"itemStatus": "E"
}
]
}| code | description |
|---|---|
| 200 | The API Response contains the current status of the upload request. |
| 204 | No Content If no records are found for the provided request, the API will respond with a No Content status. |
| 400 | Bad request. Invalid parameters or missing required information. |
| 401 | Unauthorized access. The request requires user authentication. |
| 500 | Internal server error. An error occurred while processing the request. |